home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / kickstart tools / makekick / makekick.doc < prev    next >
Text File  |  1996-04-07  |  4KB  |  108 lines
  1.  
  2.                                  MakeKick 1.0
  3.  
  4.                        (c) 1993 MJSoft System Software
  5.  
  6.                                  Martin Mares
  7.  
  8. ==============================================================================
  9.  
  10.  
  11. Introduction
  12. ------------
  13.  
  14.    This utility has been writen for easy creation of kickstart header files
  15. (*.kick).  It's able to convert the old-style files (*.RTB, *.PAT) to the
  16. kickstart header source (*.kshd) and to compile the source.
  17.  
  18.    MakeKick and its documentation are Copyright (C) MJSoft System Software
  19. 1993, Prague, Czech Republic. They may be distributed only as a part of the
  20. MKick archive. Distribution in the SKick archive is also permitted.
  21.  
  22.  
  23. Parameters
  24. ----------
  25.  
  26.    MakeKick can be started only from CLI with following parameters:
  27.  
  28. KSNAME - kickstart base name (for example kick39106.A1200).
  29.  
  30. AUTO/S - generate the source file automatically from RTB, PAT and the
  31. kickstart image file.
  32.  
  33. KICKTO/K - store processed kickstart to specified file in ROM Image format.
  34. Used mostly for conversion of files extracted from SuperKickstart disks or
  35. for decoding of encrypted kickstart files (new beta-releases for A600).
  36.  
  37.  
  38. Notes
  39. -----
  40.  
  41.    MakeKick currently supports ROM Image, KickIt, SuperKickstart and Encrypted
  42.    file formats.
  43.  
  44.    The BCPL-relocations are NOT converted from the old-style files.
  45.  
  46.    The relocation table is taken from the RTB file in both modes of operation.
  47. (it isn't included in the KSHD source file).
  48.  
  49.    MakeKick creates automatically following patches (in AUTO mode only):
  50.  
  51.         - The C0-RAM end patch (see the C0END command)
  52.         - The NO-C0-RAM patch (see the C0PATCH command)
  53.         - The CHIP-RAM-STACK patch (needed to use kick V39+ on systems
  54.           with only 1MB of CHIP RAM)
  55.  
  56.  
  57. Kickstart header source file
  58. ----------------------------
  59.  
  60.    It's a plain ASCII file containing commands on separate lines. You can
  61. write one long command (useful especially for long patches) on more lines
  62. using the '\' character on the end of each line excluding the last one.
  63. Comments are prefixed with ';'.
  64.  
  65.    Commands:
  66.  
  67. ADDRESS <hex-address> - base address of the kickstart. All following addresses
  68. will be relative to this base address.
  69.  
  70. LENGTH <hex-length> - kickstart image length in bytes
  71.  
  72. VERSION <dec>.<dec> - kickstart version
  73.  
  74. DISKPOS <hex-position> - use direct (track-) loading from the Kickstart Disk
  75. starting at given relative offset (in bytes from start of the disk - see
  76. doc of trackdisk.device).
  77.  
  78. PATCH <hex-address> <hex-list> - use given patch. The list of values is a list
  79. of hexadecimal 8-bit numbers. The numbers can be separated by spaces or tabs.
  80.  
  81. RELPATCH <hex-address> <hex-rel-long> - use given relative patch. The base
  82. address of the kickstart (in RAM) will be added to <hex-rel-long> during the
  83. patching process.
  84.  
  85. C0PATCH <hex-address> <hex-list> - patch used when the kickstart is being
  86. loaded on address C00000.
  87.  
  88. BREL <hex-long-list> - a list of BCPL-relocations. Used only when kicking KS
  89. 1.3 or lower. (MKick isn't able to kick 1.3, but it supports this type
  90. of relocations.)
  91.  
  92. C0END <hex-address> - address of the $00DC0000 longword in C0-memory test
  93. routine. It will be patched when kicking to C0-RAM. More addresses can be
  94. specified and are separated by spaces.
  95.  
  96. CHECKSUM <hex-long> - original kickstart checksum. This checksum will be
  97. checked during the kicking process to find out if the kickstart image is the
  98. corresponding one for this header file.
  99.  
  100. AUTOSUM - use automatical checksum on each reset. Used mostly for kickstarts
  101. without their own auto-checksum mechanism (34.005 and 39.110.A500).
  102.  
  103. PATCH1 ... - same as PATCH, but used only when kicking with KS 1.x in ROM.
  104. Used only by MKick.
  105.  
  106. PATCH2 ... - same as PATCH, but used only when kicking with KS 2.0 or higher
  107. in ROM. Used only by SKick.
  108.